<!doctype html>
<html>
<head>
<meta charset='UTF-8'><meta name='viewport' content='width=device-width initial-scale=1'>
<title>api-doc.md</title><link href='http://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext' rel='stylesheet' type='text/css'><style type='text/css'>html, body {overflow-x: initial !important;}.CodeMirror { height: auto; }
.CodeMirror-scroll { overflow-y: hidden; overflow-x: auto; }
.CodeMirror-lines { padding: 4px 0px; }
.CodeMirror pre { }
.CodeMirror-scrollbar-filler, .CodeMirror-gutter-filler { background-color: white; }
.CodeMirror-gutters { border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); background-color: rgb(247, 247, 247); white-space: nowrap; }
.CodeMirror-linenumbers { }
.CodeMirror-linenumber { padding: 0px 3px 0px 5px; text-align: right; color: rgb(153, 153, 153); }
.CodeMirror div.CodeMirror-cursor { border-left-width: 1px; border-left-style: solid; border-left-color: black; z-index: 3; }
.CodeMirror div.CodeMirror-secondarycursor { border-left-width: 1px; border-left-style: solid; border-left-color: silver; }
.CodeMirror.cm-keymap-fat-cursor div.CodeMirror-cursor { width: auto; border: 0px; background-color: rgb(119, 238, 119); z-index: 1; background-position: initial initial; background-repeat: initial initial; }
.CodeMirror div.CodeMirror-cursor.CodeMirror-overwrite { }
.cm-tab { display: inline-block; }
.cm-s-typora-default .cm-header, .cm-s-typora-default .cm-property { color: rgb(217, 79, 138); }
.cm-s-typora-default pre.cm-header1:not(.cm-atom) :not(.cm-overlay) { font-size: 2rem; line-height: 2rem; }
.cm-s-typora-default pre.cm-header2:not(.cm-atom) :not(.cm-overlay) { font-size: 1.4rem; line-height: 1.4rem; }
.cm-s-typora-default .cm-atom, .cm-s-typora-default .cm-number { color: rgb(149, 132, 134); }
.cm-s-typora-default .cm-table-row, .cm-s-typora-default .cm-block-start { font-family: monospace; }
.cm-s-typora-default .cm-comment, .cm-s-typora-default .cm-code { color: rgb(74, 90, 159); font-family: monospace; }
.cm-s-typora-default .cm-tag { color: rgb(169, 68, 66); }
.cm-s-typora-default .cm-string { color: rgb(126, 134, 169); }
.cm-s-typora-default .cm-link { color: rgb(196, 122, 15); text-decoration: underline; }
.cm-s-typora-default .cm-variable-2, .cm-s-typora-default .cm-variable-1 { color: inherit; }
.cm-s-typora-default .cm-overlay { font-size: 1rem; font-family: monospace; }
.CodeMirror.cm-s-typora-default div.CodeMirror-cursor { border-left-width: 3px; border-left-style: solid; border-left-color: rgb(228, 98, 154); }
.cm-s-typora-default .CodeMirror-activeline-background { left: -60px; right: -30px; background-color: rgba(204, 204, 204, 0.2); background-position: initial initial; background-repeat: initial initial; }
.cm-s-typora-default .CodeMirror-gutters { border-right-style: none; background-color: inherit; }
.cm-s-typora-default .cm-trailing-space-new-line::after, .cm-startspace::after, .cm-starttab .cm-tab::after { content: '•'; position: absolute; left: 0px; opacity: 0; font-family: LetterGothicStd, monospace; }
.os-windows .cm-startspace::after, .os-windows .cm-starttab .cm-tab::after { left: -0.1em; }
.cm-starttab .cm-tab::after { content: ' '; }
.cm-startspace, .cm-tab, .cm-starttab, .cm-trailing-space-a, .cm-trailing-space-b, .cm-trailing-space-new-line { font-family: monospace; position: relative; }
.cm-s-typora-default .cm-trailing-space-new-line::after { content: '↓'; opacity: 0.3; }
.cm-s-inner .cm-keyword { color: rgb(119, 0, 136); }
.cm-s-inner .cm-atom, .cm-s-inner.cm-atom { color: rgb(34, 17, 153); }
.cm-s-inner .cm-number { color: rgb(17, 102, 68); }
.cm-s-inner .cm-def { color: rgb(0, 0, 255); }
.cm-s-inner .cm-variable { color: black; }
.cm-s-inner .cm-variable-2 { color: rgb(0, 85, 170); }
.cm-s-inner .cm-variable-3 { color: rgb(0, 136, 85); }
.cm-s-inner .cm-property { color: black; }
.cm-s-inner .cm-operator { color: rgb(152, 26, 26); }
.cm-s-inner .cm-comment, .cm-s-inner.cm-comment { color: rgb(170, 85, 0); }
.cm-s-inner .cm-string { color: rgb(170, 17, 17); }
.cm-s-inner .cm-string-2 { color: rgb(255, 85, 0); }
.cm-s-inner .cm-meta { color: rgb(85, 85, 85); }
.cm-s-inner .cm-qualifier { color: rgb(85, 85, 85); }
.cm-s-inner .cm-builtin { color: rgb(51, 0, 170); }
.cm-s-inner .cm-bracket { color: rgb(153, 153, 119); }
.cm-s-inner .cm-tag { color: rgb(17, 119, 0); }
.cm-s-inner .cm-attribute { color: rgb(0, 0, 204); }
.cm-s-inner .cm-header, .cm-s-inner.cm-header { color: blue; }
.cm-s-inner .cm-quote, .cm-s-inner.cm-quote { color: rgb(0, 153, 0); }
.cm-s-inner .cm-hr, .cm-s-inner.cm-hr { color: rgb(153, 153, 153); }
.cm-s-inner .cm-link, .cm-s-inner.cm-link { color: rgb(0, 0, 204); }
.cm-negative { color: rgb(221, 68, 68); }
.cm-positive { color: rgb(34, 153, 34); }
.cm-header, .cm-strong { font-weight: bold; }
.cm-del { text-decoration: line-through; }
.cm-em { font-style: italic; }
.cm-link { text-decoration: underline; }
.cm-error { color: rgb(255, 0, 0); }
.cm-invalidchar { color: rgb(255, 0, 0); }
.cm-constant { color: rgb(38, 139, 210); }
.cm-defined { color: rgb(181, 137, 0); }
div.CodeMirror span.CodeMirror-matchingbracket { color: rgb(0, 255, 0); }
div.CodeMirror span.CodeMirror-nonmatchingbracket { color: rgb(255, 34, 34); }
.cm-s-inner .CodeMirror-activeline-background { background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; background-position: inherit inherit; background-repeat: inherit inherit; }
.CodeMirror { position: relative; overflow: hidden; }
.CodeMirror-scroll { margin-bottom: -30px; margin-right: -30px; padding-bottom: 30px; padding-right: 30px; height: 100%; outline: none; position: relative; box-sizing: content-box; }
.CodeMirror-sizer { position: relative; }
.CodeMirror-vscrollbar, .CodeMirror-hscrollbar, .CodeMirror-scrollbar-filler, .CodeMirror-gutter-filler { position: absolute; z-index: 6; display: none; }
.CodeMirror-vscrollbar { right: 0px; top: 0px; overflow-x: hidden; overflow-y: scroll; }
.CodeMirror-hscrollbar { bottom: 0px; left: 0px; overflow-y: hidden; overflow-x: scroll; }
.CodeMirror-scrollbar-filler { right: 0px; bottom: 0px; }
.CodeMirror-gutter-filler { left: 0px; bottom: 0px; }
.CodeMirror-gutters { position: absolute; left: 0px; top: 0px; padding-bottom: 30px; z-index: 3; }
.CodeMirror-gutter { white-space: normal; height: 100%; box-sizing: content-box; padding-bottom: 30px; margin-bottom: -32px; display: inline-block; }
.CodeMirror-gutter-elt { position: absolute; cursor: default; z-index: 4; }
.CodeMirror-lines { cursor: text; }
.CodeMirror pre { border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; border-width: 0px; background-color: transparent; font-family: inherit; font-size: inherit; margin: 0px; white-space: pre; word-wrap: normal; color: inherit; z-index: 2; position: relative; overflow: visible; background-position: initial initial; background-repeat: initial initial; }
.CodeMirror-wrap pre { word-wrap: break-word; white-space: pre-wrap; word-break: normal; }
.CodeMirror-code pre { border-right-width: 30px; border-right-style: solid; border-right-color: transparent; width: -webkit-fit-content; }
.CodeMirror-wrap .CodeMirror-code pre { border-right-style: none; width: auto; }
.CodeMirror-linebackground { position: absolute; left: 0px; right: 0px; top: 0px; bottom: 0px; z-index: 0; }
.CodeMirror-linewidget { position: relative; z-index: 2; overflow: auto; }
.CodeMirror-widget { }
.CodeMirror-wrap .CodeMirror-scroll { overflow-x: hidden; }
.CodeMirror-measure { position: absolute; width: 100%; height: 0px; overflow: hidden; visibility: hidden; }
.CodeMirror-measure pre { position: static; }
.CodeMirror div.CodeMirror-cursor { position: absolute; visibility: hidden; border-right-style: none; width: 0px; }
.CodeMirror div.CodeMirror-cursor { visibility: hidden; }
.CodeMirror-focused div.CodeMirror-cursor { visibility: inherit; }
.CodeMirror-selected { background-color: rgb(217, 217, 217); background-position: initial initial; background-repeat: initial initial; }
.CodeMirror-focused .CodeMirror-selected { background-color: rgb(215, 212, 240); background-position: initial initial; background-repeat: initial initial; }
.cm-searching { background-color: rgba(255, 255, 0, 0.4); background-position: initial initial; background-repeat: initial initial; }
.CodeMirror span { }
@media print { 
  .CodeMirror div.CodeMirror-cursor { visibility: hidden; }
}
.CodeMirror-lint-markers { width: 16px; }
.CodeMirror-lint-tooltip { background-color: infobackground; border: 1px solid black; border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px; color: infotext; font-family: monospace; overflow: hidden; padding: 2px 5px; position: fixed; white-space: pre-wrap; z-index: 10000; max-width: 600px; opacity: 0; -webkit-transition: opacity 0.4s; transition: opacity 0.4s; font-size: 0.8em; }
.CodeMirror-lint-mark-error, .CodeMirror-lint-mark-warning { background-position: 0% 100%; background-repeat: repeat no-repeat; }
.CodeMirror-lint-mark-error { background-image: url(); }
.CodeMirror-lint-marker-error, .CodeMirror-lint-marker-warning { cursor: pointer; display: inline-block; height: 16px; width: 16px; vertical-align: middle; position: relative; background-position: 50% 50%; background-repeat: no-repeat no-repeat; }
.CodeMirror-lint-message-error, .CodeMirror-lint-message-warning { padding-left: 18px; background-position: 0% 0%; background-repeat: no-repeat no-repeat; }
.CodeMirror-lint-marker-error, .CodeMirror-lint-message-error { background-image: url(); }
.CodeMirror-lint-marker-warning, .CodeMirror-lint-message-warning { background-image: url(); }
.CodeMirror-lint-marker-multiple { background-image: url(); width: 100%; height: 100%; background-position: 100% 100%; background-repeat: no-repeat no-repeat; }


html { font-size: 14px; background-color: rgb(255, 255, 255); color: rgb(51, 51, 51); }
body { margin: 0px; padding: 0px; height: auto; bottom: 0px; top: 0px; left: 0px; right: 0px; font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif; font-size: 1rem; line-height: 1.42857143; overflow-x: hidden; background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; background-position: inherit inherit; background-repeat: inherit inherit; }
a:active, a:hover { outline: 0px; }
.in-text-selection, ::selection { background-color: rgb(181, 214, 252); text-shadow: none; background-position: initial initial; background-repeat: initial initial; }
#write { margin: 0px auto; height: auto; width: inherit; word-break: normal; word-wrap: break-word; position: relative; padding-bottom: 70px; white-space: pre-wrap; overflow-x: auto; }
.for-image #write { padding-left: 8px; padding-right: 8px; }
body.typora-export { padding-left: 30px; padding-right: 30px; }
@media screen and (max-width: 500px) { 
  body.typora-export { padding-left: 0px; padding-right: 0px; }
  .CodeMirror-sizer { margin-left: 0px !important; }
  .CodeMirror-gutters { display: none !important; }
}
.typora-export #write { margin: 0px auto; }
#write > p:first-child, #write > ul:first-child, #write > ol:first-child, #write > pre:first-child, #write > blockquote:first-child, #write > div:first-child, #write > table:first-child { margin-top: 30px; }
#write li > table:first-child { margin-top: -20px; }
img { max-width: 100%; vertical-align: middle; }
input, button, select, textarea { color: inherit; font-family: inherit; font-size: inherit; font-style: inherit; font-variant-caps: inherit; font-weight: inherit; line-height: inherit; }
input[type="checkbox"], input[type="radio"] { line-height: normal; padding: 0px; }
::before, ::after, * { box-sizing: border-box; }
#write p, #write h1, #write h2, #write h3, #write h4, #write h5, #write h6, #write div, #write pre { width: inherit; }
#write p, #write h1, #write h2, #write h3, #write h4, #write h5, #write h6 { position: relative; }
h1 { font-size: 2rem; }
h2 { font-size: 1.8rem; }
h3 { font-size: 1.6rem; }
h4 { font-size: 1.4rem; }
h5 { font-size: 1.2rem; }
h6 { font-size: 1rem; }
p { -webkit-margin-before: 1rem; -webkit-margin-after: 1rem; -webkit-margin-start: 0px; -webkit-margin-end: 0px; }
.mathjax-block { margin-top: 0px; margin-bottom: 0px; -webkit-margin-before: 0rem; -webkit-margin-after: 0rem; }
.hidden { display: none; }
.md-blockmeta { color: rgb(204, 204, 204); font-weight: bold; font-style: italic; }
a { cursor: pointer; }
#write input[type="checkbox"] { cursor: pointer; width: inherit; height: inherit; margin: 4px 0px 0px; }
tr { page-break-inside: avoid; page-break-after: auto; }
thead { display: table-header-group; }
table { border-collapse: collapse; border-spacing: 0px; width: 100%; overflow: auto; page-break-inside: auto; text-align: left; }
table.md-table td { min-width: 80px; }
.CodeMirror-gutters { border-right-width: 0px; background-color: inherit; }
.CodeMirror { text-align: left; }
.CodeMirror-placeholder { opacity: 0.3; }
.CodeMirror pre { padding: 0px 4px; }
.CodeMirror-lines { padding: 0px; }
div.hr:focus { cursor: none; }
pre { white-space: pre-wrap; }
.CodeMirror-gutters { margin-right: 4px; }
.md-fences { font-size: 0.9rem; display: block; page-break-inside: avoid; text-align: left; overflow: visible; white-space: pre; background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; position: relative !important; background-position: inherit inherit; background-repeat: inherit inherit; }
.md-diagram-panel { width: 100%; margin-top: 10px; text-align: center; padding-top: 0px; padding-bottom: 8px; overflow-x: auto; }
.md-fences .CodeMirror.CodeMirror-wrap { top: -1.6em; margin-bottom: -1.6em; }
.md-fences.mock-cm { white-space: pre-wrap; }
.show-fences-line-number .md-fences { padding-left: 0px; }
.show-fences-line-number .md-fences.mock-cm { padding-left: 40px; }
.footnotes { opacity: 0.8; font-size: 0.9rem; padding-top: 1em; padding-bottom: 1em; }
.footnotes + .footnotes { margin-top: -1em; }
.md-reset { margin: 0px; padding: 0px; border: 0px; outline: 0px; vertical-align: top; background-color: transparent; text-decoration: none; text-shadow: none; float: none; position: static; width: auto; height: auto; white-space: nowrap; cursor: inherit; line-height: normal; font-weight: normal; text-align: left; box-sizing: content-box; direction: ltr; background-position: initial initial; background-repeat: initial initial; }
li div { padding-top: 0px; }
blockquote { margin: 1rem 0px; }
li p, li .mathjax-block { margin: 0.5rem 0px; }
li { margin: 0px; position: relative; }
blockquote > :last-child { margin-bottom: 0px; }
blockquote > :first-child { margin-top: 0px; }
.footnotes-area { color: rgb(136, 136, 136); margin-top: 0.714rem; padding-bottom: 0.143rem; }
@media print { 
  html, body { height: 100%; }
  .typora-export * { -webkit-print-color-adjust: exact; }
  h1, h2, h3, h4, h5, h6 { page-break-after: avoid; orphans: 2; }
  p { orphans: 4; }
  html.blink-to-pdf { font-size: 13px; }
  .typora-export #write { padding-left: 1cm; padding-right: 1cm; }
  .typora-export #write::after { height: 0px; }
  @page { margin: 20mm 0mm; }
}
.footnote-line { margin-top: 0.714em; font-size: 0.7em; }
a img, img a { cursor: pointer; }
pre.md-meta-block { font-size: 0.8rem; min-height: 2.86rem; white-space: pre-wrap; background-color: rgb(204, 204, 204); display: block; overflow-x: hidden; background-position: initial initial; background-repeat: initial initial; }
p .md-image:only-child { display: inline-block; width: 100%; text-align: center; }
#write .MathJax_Display { margin: 0.8em 0px 0px; }
.mathjax-block { white-space: pre; overflow: hidden; width: 100%; }
p + .mathjax-block { margin-top: -1.143rem; }
.mathjax-block:not(:empty)::after { display: none; }
[contenteditable="true"]:active, [contenteditable="true"]:focus { outline: none; box-shadow: none; }
.task-list { list-style-type: none; }
.task-list-item { position: relative; padding-left: 1em; }
.task-list-item input { position: absolute; top: 0px; left: 0px; }
.math { font-size: 1rem; }
.md-toc { min-height: 3.58rem; position: relative; font-size: 0.9rem; border-top-left-radius: 10px; border-top-right-radius: 10px; border-bottom-right-radius: 10px; border-bottom-left-radius: 10px; }
.md-toc-content { position: relative; margin-left: 0px; }
.md-toc::after, .md-toc-content::after { display: none; }
.md-toc-item { display: block; color: rgb(65, 131, 196); text-decoration: none; }
.md-toc-inner:hover { }
.md-toc-inner { display: inline-block; cursor: pointer; }
.md-toc-h1 .md-toc-inner { margin-left: 0px; font-weight: bold; }
.md-toc-h2 .md-toc-inner { margin-left: 2em; }
.md-toc-h3 .md-toc-inner { margin-left: 4em; }
.md-toc-h4 .md-toc-inner { margin-left: 6em; }
.md-toc-h5 .md-toc-inner { margin-left: 8em; }
.md-toc-h6 .md-toc-inner { margin-left: 10em; }
@media screen and (max-width: 48em) { 
  .md-toc-h3 .md-toc-inner { margin-left: 3.5em; }
  .md-toc-h4 .md-toc-inner { margin-left: 5em; }
  .md-toc-h5 .md-toc-inner { margin-left: 6.5em; }
  .md-toc-h6 .md-toc-inner { margin-left: 8em; }
}
a.md-toc-inner { font-size: inherit; font-style: inherit; font-weight: inherit; line-height: inherit; }
.footnote-line a:not(.reversefootnote) { color: inherit; }
.md-attr { display: none; }
.md-fn-count::after { content: '.'; }
.md-tag { opacity: 0.5; }
.md-comment { color: rgb(162, 127, 3); opacity: 0.8; font-family: monospace; }
code { text-align: left; }
h1 .md-tag, h2 .md-tag, h3 .md-tag, h4 .md-tag, h5 .md-tag, h6 .md-tag { font-weight: initial; opacity: 0.35; }
a.md-print-anchor { border: none !important; display: inline-block !important; position: absolute !important; width: 1px !important; right: 0px !important; outline: none !important; background-color: transparent !important; text-shadow: initial !important; background-position: initial initial !important; background-repeat: initial initial !important; }
.md-inline-math .MathJax_SVG .noError { display: none !important; }
.mathjax-block .MathJax_SVG_Display { text-align: center; margin: 1em 0em; position: relative; text-indent: 0px; max-width: none; max-height: none; min-height: 0px; min-width: 100%; width: auto; display: block !important; }
.MathJax_SVG_Display, .md-inline-math .MathJax_SVG_Display { width: auto; margin: inherit; display: inline-block !important; }
.MathJax_SVG .MJX-monospace { font-family: monospace; }
.MathJax_SVG .MJX-sans-serif { font-family: sans-serif; }
.MathJax_SVG { display: inline; font-style: normal; font-weight: normal; line-height: normal; zoom: 90%; text-indent: 0px; text-align: left; text-transform: none; letter-spacing: normal; word-spacing: normal; word-wrap: normal; white-space: nowrap; float: none; direction: ltr; max-width: none; max-height: none; min-width: 0px; min-height: 0px; border: 0px; padding: 0px; margin: 0px; }
.MathJax_SVG * { -webkit-transition: none; transition: none; }


@include-when-export url(http://fonts.googleapis.com/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext);

/**
 * css forked from https://github.com/GitbookIO/gitbook 
 * www.gitbook.com
 * Apache License
 * https://github.com/GitbookIO/gitbook/blob/master/LICENSE
 **/

@font-face {
    font-family: 'Open Sans';
    font-style: normal;
    font-weight: normal;
    src: local('Open Sans Regular'),url('file:///Users/Misa/Library/Application%20Support/abnerworks.Typora/themes/github/400.woff') format('woff')
}

@font-face {
    font-family: 'Open Sans';
    font-style: italic;
    font-weight: normal;
    src: local('Open Sans Italic'),url('file:///Users/Misa/Library/Application%20Support/abnerworks.Typora/themes/github/400i.woff') format('woff')
}

@font-face {
    font-family: 'Open Sans';
    font-style: normal;
    font-weight: bold;
    src: local('Open Sans Bold'),url('file:///Users/Misa/Library/Application%20Support/abnerworks.Typora/themes/github/700.woff') format('woff')
}

@font-face {
    font-family: 'Open Sans';
    font-style: italic;
    font-weight: bold;
    src: local('Open Sans Bold Italic'),url('file:///Users/Misa/Library/Application%20Support/abnerworks.Typora/themes/github/700i.woff') format('woff')
}

html {
    font-size: 16px;
}

body {
    font-family: "Open Sans","Clear Sans","Helvetica Neue",Helvetica,Arial,sans-serif;
    color: rgb(51, 51, 51);
    line-height: 1.6;
}

#write{
    max-width: 860px;
  	margin: 0 auto;
  	padding: 20px 30px 40px 30px;
	padding-top: 20px;
    padding-bottom: 100px;
}
#write > ul:first-child,
#write > ol:first-child{
    margin-top: 30px;
}

body > *:first-child {
    margin-top: 0 !important;
}
body > *:last-child {
    margin-bottom: 0 !important;
}
a {
    color: #4183C4;
}
h1,
h2,
h3,
h4,
h5,
h6 {
    position: relative;
    margin-top: 1rem;
    margin-bottom: 1rem;
    font-weight: bold;
    line-height: 1.4;
    cursor: text;
}
h1:hover a.anchor,
h2:hover a.anchor,
h3:hover a.anchor,
h4:hover a.anchor,
h5:hover a.anchor,
h6:hover a.anchor {
    /*background: url("file:///Users/Misa/Library/Application%20Support/images/modules/styleguide/para.png") no-repeat 10px center;*/
    text-decoration: none;
}
h1 tt,
h1 code {
    font-size: inherit;
}
h2 tt,
h2 code {
    font-size: inherit;
}
h3 tt,
h3 code {
    font-size: inherit;
}
h4 tt,
h4 code {
    font-size: inherit;
}
h5 tt,
h5 code {
    font-size: inherit;
}
h6 tt,
h6 code {
    font-size: inherit;
}
h1 {
    padding-bottom: .3em;
    font-size: 2.25em;
    line-height: 1.2;
    border-bottom: 1px solid #eee;
}
h2 {
   padding-bottom: .3em;
    font-size: 1.75em;
    line-height: 1.225;
    border-bottom: 1px solid #eee;
}
h3 {
    font-size: 1.5em;
    line-height: 1.43;
}
h4 {
    font-size: 1.25em;
}
h5 {
    font-size: 1em;
}
h6 {
   font-size: 1em;
    color: #777;
}
p,
blockquote,
ul,
ol,
dl,
table{
    margin: 0.8em 0;
}
li>ol,
li>ul {
    margin: 0 0;
}
hr {
    height: 4px;
    padding: 0;
    margin: 16px 0;
    background-color: #e7e7e7;
    border: 0 none;
    overflow: hidden;
    box-sizing: content-box;
    border-bottom: 1px solid #ddd;
}

body > h2:first-child {
    margin-top: 0;
    padding-top: 0;
}
body > h1:first-child {
    margin-top: 0;
    padding-top: 0;
}
body > h1:first-child + h2 {
    margin-top: 0;
    padding-top: 0;
}
body > h3:first-child,
body > h4:first-child,
body > h5:first-child,
body > h6:first-child {
    margin-top: 0;
    padding-top: 0;
}
a:first-child h1,
a:first-child h2,
a:first-child h3,
a:first-child h4,
a:first-child h5,
a:first-child h6 {
    margin-top: 0;
    padding-top: 0;
}
h1 p,
h2 p,
h3 p,
h4 p,
h5 p,
h6 p {
    margin-top: 0;
}
li p.first {
    display: inline-block;
}
ul,
ol {
    padding-left: 30px;
}
ul:first-child,
ol:first-child {
    margin-top: 0;
}
ul:last-child,
ol:last-child {
    margin-bottom: 0;
}
blockquote {
    border-left: 4px solid #dddddd;
    padding: 0 15px;
    color: #777777;
}
blockquote blockquote {
    padding-right: 0;
}
table {
    padding: 0;
    word-break: initial;
}
table tr {
    border-top: 1px solid #cccccc;
    background-color: white;
    margin: 0;
    padding: 0;
}
table tr:nth-child(2n) {
    background-color: #f8f8f8;
}
table tr th {
    font-weight: bold;
    border: 1px solid #cccccc;
    text-align: left;
    margin: 0;
    padding: 6px 13px;
}
table tr td {
    border: 1px solid #cccccc;
    text-align: left;
    margin: 0;
    padding: 6px 13px;
}
table tr th:first-child,
table tr td:first-child {
    margin-top: 0;
}
table tr th:last-child,
table tr td:last-child {
    margin-bottom: 0;
}

.CodeMirror-gutters {
    border-right: 1px solid #ddd;
}

.md-fences,
code,
tt {
    border: 1px solid #ddd;
    background-color: #f8f8f8;
    border-radius: 3px;
    padding: 0;
    font-family: Consolas, "Liberation Mono", Courier, monospace;
    padding: 2px 4px 0px 4px;
    font-size: 0.9em;
}

.md-fences {
    margin-bottom: 15px;
    margin-top: 15px;
    padding: 0.2em 1em;
    padding-top: 8px;
    padding-bottom: 6px;
}
.task-list{
	padding-left: 0;
}

.task-list-item {
	padding-left:32px;
}

.task-list-item input {
  top: 3px;
  left: 8px;
}

@media screen and (min-width: 914px) {
    /*body {
        width: 854px;
        margin: 0 auto;
    }*/
}
@media print {
    html {
        font-size: 13px;
    }
    table,
    pre {
        page-break-inside: avoid;
    }
    pre {
        word-wrap: break-word;
    }
}

.md-fences {
	background-color: #f8f8f8;
}
#write pre.md-meta-block {
	padding: 1rem;
    font-size: 85%;
    line-height: 1.45;
    background-color: #f7f7f7;
    border: 0;
    border-radius: 3px;
    color: #777777;
    margin-top: 0 !important;
}

.mathjax-block>.code-tooltip {
	bottom: .375rem;
}

#write>h3.md-focus:before{
	left: -1.5625rem;
	top: .375rem;
}
#write>h4.md-focus:before{
	left: -1.5625rem;
	top: .285714286rem;
}
#write>h5.md-focus:before{
	left: -1.5625rem;
	top: .285714286rem;
}
#write>h6.md-focus:before{
	left: -1.5625rem;
	top: .285714286rem;
}
.md-image>.md-meta {
    border: 1px solid #ddd;
    border-radius: 3px;
    font-family: Consolas, "Liberation Mono", Courier, monospace;
    padding: 2px 4px 0px 4px;
    font-size: 0.9em;
    color: inherit;
}

.md-tag{
	color: inherit;
}

.md-toc { 
    margin-top:20px;
    padding-bottom:20px;
}

#typora-quick-open {
    border: 1px solid #ddd;
    background-color: #f8f8f8;
}

#typora-quick-open-item {
    background-color: #FAFAFA;
    border-color: #FEFEFE #e5e5e5 #e5e5e5 #eee;
    border-style: solid;
    border-width: 1px;
}

#md-notification:before {
    top: 10px;
}

/** focus mode */
.on-focus-mode blockquote {
    border-left-color: rgba(85, 85, 85, 0.12);
}

header, .context-menu, .megamenu-content, footer{
    font-family: "Segoe UI", "Arial", sans-serif;
}


</style>
</head>
<body class='typora-export' >
<div  id='write'  class = 'is-mac'><h1><a name='header-c5' class='md-header-anchor '></a>edoolive-tencent</h1><table><thead><tr><th>变更时间</th><th>变更内容</th><th>撰写人</th></tr></thead><tbody><tr><td>2017/03/15</td><td>创建edoolive-tencent的接口文档，创建聊天室功能</td><td>刘畅</td></tr><tr><td>2017/03/15</td><td>加入微信中控服务器文档</td><td>刘畅</td></tr><tr><td>2017/04/01</td><td>更改JS-ticket接口返回，加入UserToken接口功能</td><td>刘畅</td></tr></tbody></table><div class='md-toc' mdtype='toc'><p class="md-toc-content"><span class="md-toc-item md-toc-h1" data-ref="c5"><a class="md-toc-inner" style="" href="#header-c5">edoolive-tencent</a></span><span class="md-toc-item md-toc-h2" data-ref="c25"><a class="md-toc-inner" style="" href="#header-c25">1.1  公众号 / 全局唯一票据(access_token)</a></span><span class="md-toc-item md-toc-h3" data-ref="c26"><a class="md-toc-inner" style="" href="#header-c26">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c30"><a class="md-toc-inner" style="" href="#header-c30">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c58"><a class="md-toc-inner" style="" href="#header-c58">1.2 公众号 / JS-SDK 全局JS Config</a></span><span class="md-toc-item md-toc-h3" data-ref="c59"><a class="md-toc-inner" style="" href="#header-c59">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c75"><a class="md-toc-inner" style="" href="#header-c75">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c90"><a class="md-toc-inner" style="" href="#header-c90">1.3 网页授权 / 微信公众号网页授权</a></span><span class="md-toc-item md-toc-h3" data-ref="c91"><a class="md-toc-inner" style="" href="#header-c91">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c95"><a class="md-toc-inner" style="" href="#header-c95">Request Param</a></span><span class="md-toc-item md-toc-h3" data-ref="c122"><a class="md-toc-inner" style="" href="#header-c122">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c135"><a class="md-toc-inner" style="" href="#header-c135">1.4 网页授权 / 获取授权结果信息</a></span><span class="md-toc-item md-toc-h3" data-ref="c136"><a class="md-toc-inner" style="" href="#header-c136">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c140"><a class="md-toc-inner" style="" href="#header-c140">Request Param</a></span><span class="md-toc-item md-toc-h3" data-ref="c152"><a class="md-toc-inner" style="" href="#header-c152">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c273"><a class="md-toc-inner" style="" href="#header-c273">2.1  用户授权/创建 User Token</a></span><span class="md-toc-item md-toc-h3" data-ref="c275"><a class="md-toc-inner" style="" href="#header-c275">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c306"><a class="md-toc-inner" style="" href="#header-c306">Request Param</a></span><span class="md-toc-item md-toc-h3" data-ref="c405"><a class="md-toc-inner" style="" href="#header-c405">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c163"><a class="md-toc-inner" style="" href="#header-c163">2.2  用户授权/提取 User Token</a></span><span class="md-toc-item md-toc-h3" data-ref="c365"><a class="md-toc-inner" style="" href="#header-c365">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c369"><a class="md-toc-inner" style="" href="#header-c369">Request Param</a></span><span class="md-toc-item md-toc-h3" data-ref="c436"><a class="md-toc-inner" style="" href="#header-c436">Response Body</a></span><span class="md-toc-item md-toc-h2" data-ref="c266"><a class="md-toc-inner" style="" href="#header-c266">3  创建腾讯聊天室</a></span><span class="md-toc-item md-toc-h3" data-ref="c164"><a class="md-toc-inner" style="" href="#header-c164">Request URL</a></span><span class="md-toc-item md-toc-h3" data-ref="c168"><a class="md-toc-inner" style="" href="#header-c168">Request Param</a></span><span class="md-toc-item md-toc-h3" data-ref="c195"><a class="md-toc-inner" style="" href="#header-c195">Response Body</a></span></p></div><h2><a name='header-c25' class='md-header-anchor '></a>1.1  公众号 / 全局唯一票据(access_token)</h2><h3><a name='header-c26' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>GET   /wechat/access-token</strong></p></blockquote><h3><a name='header-c30' class='md-header-anchor '></a>Response Body</h3><p>获取到的accessToken将会在微信中控服务器被缓存7140秒，expire为改accessToken在中控服务器的过期时间戳。</p><p>返回结果有两种形式：json、jsonp</p><p></p><p>json格式返回结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap   "><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"data"</span>: {</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"accessToken"</span>: <span class="cm-string">"_wg63tigOjJSG5GQA5C1ecVModigNzwPCkvBFFYbRG9LSvq9RdRhItYFrTieOhPBAFuD3bOoYufxuttlBL-7cjbI3WnpRKo3IfvDkwhgKiOt6Ptv7r16wtvsuz1j4CLBCFWjAAAORI"</span>,</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expire"</span>: <span class="cm-number">1488964985483</span></span></pre><pre class=""><span style="padding-right: 0.1px;">  }</span></pre><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 198px;"></div></div></div></pre><p></p><p>jsonp格式返回结果：</p><p>​	customeJsonpCallback为自定义jsonp返回头</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap"><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;"><span class="cm-comment">/**/</span><span class="cm-variable">customeJsonpCallback</span>({</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"access_token"</span>: <span class="cm-string">"UHfYDJQ3A4A_odF8IJH8DKhar9QIcoOehm1TiL6-NJ7uXWt7jEUMX0YdxAlWusypqitCZOmH7PaFY7S9-1a2bYr5_H1yKeFkU7iD_cnV6cDIjMZmdEsGvzmfFLLeFvFBSGKaAGAIWA"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"expire"</span>: <span class="cm-number">1488965639413</span></span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;">});</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 198px;"></div></div></div></pre><p></p><p>错误结果以及错误类型：</p><p>我们将微信的全局授权错误返回码与返回信息封装成如下格式返回给调用端，使客户端能及时收到错误信息</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap"><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code"><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"message"</span>: <span class="cm-string">"invalid appid"</span></span></pre><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 88px;"></div></div></div></pre><p>微信全局返回码：<a href='https://mp.weixin.qq.com/wiki/10/6380dc743053a91c544ffd2b7c959166.html' target='_blank' >https://mp.weixin.qq.com/wiki/10/6380dc743053a91c544ffd2b7c959166.html</a></p><p></p><h2><a name='header-c58' class='md-header-anchor '></a>1.2 公众号 / JS-SDK 全局JS Config</h2><h3><a name='header-c59' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>GET   /wechat/js-ticket</strong></p></blockquote><h3><a name='header-c75' class='md-header-anchor '></a>Response Body</h3><p>JsConfig主要由JS-SDK全局票据（js-ticket）与当前url进行加密签名生成，其中向腾讯获取到的js-ticket将会在微信中控服务器被缓存7140秒。ticket 即为微信js-ticket内容，appid为所用微信的配置项之一，expire为此js-ticket在中控服务器的过期时间戳。</p><p>json格式返回结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap         "><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"data"</span>: {</span></pre><div class="" style="position: relative;"><pre><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"ticket"</span>: <span class="cm-string">"bxLdikRXVbTPdHSM05e5u4O4Vc3mEGx4r0fajzvQsu--u3CSXxwFBzqX2Ar8bm1Ub8t7aR93T2dHIUX5CloCag"</span>,</span></pre></div><pre><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"appid"</span>: <span class="cm-string">"wx2353d94bcac5b391"</span>,</span></pre><pre><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expire"</span>: <span class="cm-number">1491035536631</span></span></pre><pre class=""><span style="padding-right: 0.1px;">  }</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 198px;"></div></div></div></pre><p>jsonp格式返回结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap "><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;"><span class="cm-comment">/**/</span><span class="cm-variable">customeJsonpCallback</span>({</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; <span class="cm-string cm-property">"ticket"</span>: <span class="cm-string">"bxLdikRXVbTPdHSM05e5u4O4Vc3mEGx4r0fajzvQsu--u3CSXxwFBzqX2Ar8bm1Ub8t7aR93T2dHIUX5CloCag"</span>,</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; <span class="cm-string cm-property">"appid"</span>: <span class="cm-string">"wx2353d94bcac5b391"</span>,</span></pre></div><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; <span class="cm-string cm-property">"expire"</span>: <span class="cm-number">1491035536631</span></span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;">});</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 198px;"></div></div></div></pre><p>错误结果与全局授权一样，将会转化为json对象返回，详细错误码请查看微信文档。</p><p></p><h2><a name='header-c90' class='md-header-anchor '></a>1.3 网页授权 / 微信公众号网页授权</h2><h3><a name='header-c91' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>GET   /wechat/web-auth/prepare?scope=xxx&amp;redirectUrl=xxx&amp;client=xxx&amp;requestNo=xxx</strong></p></blockquote><h3><a name='header-c95' class='md-header-anchor '></a>Request Param</h3><table><thead><tr><th style='text-align:center;' >参数名称</th><th style='text-align:center;' >参数值</th><th style='text-align:center;' >参数说明</th><th style='text-align:center;' >是否必填</th></tr></thead><tbody><tr><td style='text-align:center;' >scope</td><td style='text-align:center;' >snsapi_base/ snsapi_userinfo</td><td style='text-align:center;' >微信网页授权类型</td><td style='text-align:center;' >必填</td></tr><tr><td style='text-align:center;' >redirectUrl</td><td style='text-align:center;' ><a href='http://www.client/callbackUrl' target='_blank' >http://www.client/callbackUrl</a></td><td style='text-align:center;' >授权成功回调页面地址</td><td style='text-align:center;' >必填</td></tr><tr><td style='text-align:center;' >client</td><td style='text-align:center;' ><a href='http://www.client/' target='_blank' >http://www.client/</a></td><td style='text-align:center;' >请求授权客户端域名</td><td style='text-align:center;' >必填</td></tr><tr><td style='text-align:center;' >requestNo</td><td style='text-align:center;' >121221</td><td style='text-align:center;' >唯一请求号</td><td style='text-align:center;' >必填</td></tr></tbody></table><h3><a name='header-c122' class='md-header-anchor '></a>Response Body</h3><p>SUCCESS：直接redirect到业务系统redirectUrl?uuid=xxx</p><p></p><p>请求参数client错误：微信中控服务统一错误页面</p><p></p><p>腾讯静默授权失败：client + clientErrorUrl (clientErrorUrl为微信中控服务为每个业务系统的配置项，指向各个业务系统授权失败的页面)</p><p></p><h2><a name='header-c135' class='md-header-anchor '></a>1.4 网页授权 / 获取授权结果信息</h2><h3><a name='header-c136' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>POST   /wechat/web-auth/login</strong></p></blockquote><h3><a name='header-c140' class='md-header-anchor '></a>Request Param</h3><table><thead><tr><th style='text-align:center;' >参数名称</th><th style='text-align:center;' >参数值</th><th style='text-align:center;' >参数说明</th><th style='text-align:center;' >是否必填</th></tr></thead><tbody><tr><td style='text-align:center;' >uuid</td><td style='text-align:center;' >23432432</td><td style='text-align:center;' >请求授权成功唯一返回码</td><td style='text-align:center;' >必填</td></tr></tbody></table><h3><a name='header-c152' class='md-header-anchor '></a>Response Body</h3><p>根据uuid，微信中控服务将会查询出此次授权类型，根据不同的授权类型，返回给用户不同的json格式授权结果。</p><p>静默授权（snsapi_base）返回：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap"><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"web_auth"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"id"</span>: <span class="cm-string">"37f0a863-59c4-4920-a65e-907d428f9816"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"state"</span>: <span class="cm-string">"011488965159440"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"redirect_url"</span>: <span class="cm-string">"http://zhongtouwan.com/demo2do-mobile-showcase/"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"client"</span>: <span class="cm-string">"http://zhongtouwan.com/demo2do-mobile-showcase"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"scope"</span>: <span class="cm-string">"snsapi_base"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"openid"</span>: <span class="cm-string">"oUdFywJBD08VFrBOY3v51ujnuE54"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"visited"</span>: <span class="cm-atom">true</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"account"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  </span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 374px;"></div></div></div></pre><p>非静默授权（snsapi_userinfo）返回：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap"><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"web_auth"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"id"</span>: <span class="cm-string">"b1018e7e-0f2b-4f71-aeee-e6bdc15cac7d"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"state"</span>: <span class="cm-string">"011488992299400"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"redirect_url"</span>: <span class="cm-string">"http://zhongtouwan.com/demo2do-mobile-showcase/"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"client"</span>: <span class="cm-string">"http://zhongtouwan.com/demo2do-mobile-showcase"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"scope"</span>: <span class="cm-string">"snsapi_userinfo"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"openid"</span>: <span class="cm-string">"oUdFywJBD08VFrBOY3v51ujnuE54"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"visited"</span>: <span class="cm-atom">true</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"account"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"id"</span>: <span class="cm-number">1</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"openid"</span>: <span class="cm-string">"oUdFywJBD08VFrBOY3v51ujnuE54"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"nickname"</span>: <span class="cm-string">"莫寒岚"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"sex"</span>: <span class="cm-number">1</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"province"</span>: <span class="cm-string">"浙江"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"city"</span>: <span class="cm-string">"嘉兴"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"country"</span>: <span class="cm-string">"中国"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"headimgurl"</span>: <span class="cm-string">"http://wx.qlogo.cn/mmopen/ajNVdqHZLLDAiaCKFfNXX4nDkKW3KgQvQiasia3fCUcLe0ldic1mBJKqGD0xqLKJsfnLF3EeBThKY6w3EDv7AvxsXQ/0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  <span class="cm-string cm-property">"language"</span>: <span class="cm-string">"zh_CN"</span></span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp; &nbsp; &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  }</span></pre><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 594px;"></div></div></div></pre><p></p><h2><a name='header-c273' class='md-header-anchor '></a>2.1  用户授权/创建 User Token</h2><h3><a name='header-c275' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>POST  <a href='http://test.edoolive.com/edoolive-tencent/users/' target='_blank' >http://test.edoolive.com/edoolive-tencent/users/</a>{userId}/token</strong></p></blockquote><h3><a name='header-c306' class='md-header-anchor '></a>Request Param</h3><table><thead><tr><th style='text-align:center;' >参数名称</th><th style='text-align:center;' >参数值</th><th style='text-align:center;' >参数说明</th><th style='text-align:center;' >是否必填</th></tr></thead><tbody><tr><td style='text-align:center;' >userId</td><td style='text-align:center;' >2</td><td style='text-align:center;' >用户ID</td><td style='text-align:center;' >必填</td></tr></tbody></table><h3><a name='header-c405' class='md-header-anchor '></a>Response Body</h3><p>在数据库中进行插入或修改操作，通过userId在user_token表中更新或创建新的UserToken，再通过提取接口从缓存中获取UserToken。</p><p>返回结果形式为 json。</p><p>json格式返回创建成功结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap  "><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><pre><span>xxxxxxxxxx</span></pre></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"access_token"</span>: <span class="cm-string">"eJxFkNFOgzAUht*F2xk9LSBg4sWGC*LcEHGJ86aBUWoZQm07GDG*u4yweHm*L3-Of86P8facXKdC8JykmpgyN*4MMK5GTE*CS0rSQlM5YGTbNga42JZKxZt6EBiQjbAJ8C95TmvNCz4GzQkqzoZpvdz6YezL74eF5Tuf7JFlN7AMpH55zQ5uhvS8VEfoZ**uiMpwg6suZKttG0ZO3G8*2C5ZqZ1WZZsltF-TJ28RnLqoamZFF8C8iu8vy-IDGe86N7fO1TzHuZ2k5l905B4CE2PXmni63zfHWhPdCzo*4vcPHElWoQ__"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expired"</span>: <span class="cm-atom">false</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"create_time"</span>: <span class="cm-number">1491032284000</span>,</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"user_id"</span>: <span class="cm-number">3</span>,</span></pre></div><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expire_time"</span>: <span class="cm-number">1491047836000</span>,</span></pre></div><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"id"</span>: <span class="cm-number">8</span> <span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-comment">//user_token_id</span></span></pre></div><pre class=""><span style="padding-right: 0.1px;">  }</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 310px;"></div></div></div></pre><p></p><h2><a name='header-c163' class='md-header-anchor '></a>2.2  用户授权/提取 User Token</h2><h3><a name='header-c365' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>GET <a href='http://test.edoolive.com/edoolive-tencent/users/' target='_blank' >http://test.edoolive.com/edoolive-tencent/users/</a>{userId}/token</strong></p></blockquote><h3><a name='header-c369' class='md-header-anchor '></a>Request Param</h3><table><thead><tr><th style='text-align:center;' >参数名称</th><th style='text-align:center;' >参数值</th><th style='text-align:center;' >参数说明</th><th style='text-align:center;' >是否必填</th></tr></thead><tbody><tr><td style='text-align:center;' >userId</td><td style='text-align:center;' >2</td><td style='text-align:center;' >用户ID</td><td style='text-align:center;' >必填</td></tr></tbody></table><h3><a name='header-c436' class='md-header-anchor '></a>Response Body</h3><p>从缓存中获取UserToken，缓存中UserToken设有过期时限。</p><p>返回结果形式为 json。</p><p>json格式返回创建成功结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap    "><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><pre><span>xxxxxxxxxx</span></pre></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"access_token"</span>: <span class="cm-string">"eJxFkNFOgzAUht*F2xk9LSBg4sWGC*LcEHGJ86aBUWoZQm07GDG*u4yweHm*L3-Of86P8facXKdC8JykmpgyN*4MMK5GTE*CS0rSQlM5YGTbNga42JZKxZt6EBiQjbAJ8C95TmvNCz4GzQkqzoZpvdz6YezL74eF5Tuf7JFlN7AMpH55zQ5uhvS8VEfoZ**uiMpwg6suZKttG0ZO3G8*2C5ZqZ1WZZsltF-TJ28RnLqoamZFF8C8iu8vy-IDGe86N7fO1TzHuZ2k5l905B4CE2PXmni63zfHWhPdCzo*4vcPHElWoQ__"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expired"</span>: <span class="cm-atom">false</span>,</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"create_time"</span>: <span class="cm-number">1491032284000</span>,</span></pre></div><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"user_id"</span>: <span class="cm-number">3</span>,</span></pre></div><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"expire_time"</span>: <span class="cm-number">1491047836000</span>,</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"id"</span>: <span class="cm-number">8</span><span class="cm-tab"> </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-tab">    </span><span class="cm-comment">//user_token_id</span></span></pre></div><pre class=""><span style="padding-right: 0.1px;">  }</span></pre><div class="" style="position: relative;"><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 310px;"></div></div></div></pre><p></p><p></p><h2><a name='header-c266' class='md-header-anchor '></a>3  创建腾讯聊天室</h2><h3><a name='header-c164' class='md-header-anchor '></a>Request URL</h3><blockquote><p><strong>POST  <a href='http://test.edoolive.com/edoolive-tencent/live-chat-groups' target='_blank' >http://test.edoolive.com/edoolive-tencent/live-chat-groups</a></strong></p></blockquote><h3><a name='header-c168' class='md-header-anchor '></a>Request Param</h3><table><thead><tr><th style='text-align:center;' >参数名称</th><th style='text-align:center;' >参数值</th><th style='text-align:center;' >参数说明</th><th style='text-align:center;' >是否必填</th></tr></thead><tbody><tr><td style='text-align:center;' >Owner_Account</td><td style='text-align:center;' >1</td><td style='text-align:center;' >群主ID</td><td style='text-align:center;' >是</td></tr><tr><td style='text-align:center;' >Name</td><td style='text-align:center;' >test group a</td><td style='text-align:center;' >群名称</td><td style='text-align:center;' >是</td></tr><tr><td style='text-align:center;' >Type</td><td style='text-align:center;' >Public（公开群），Private（私密群），ChatRoom（聊天室），AVChatRoom（互动直播聊天室），BChartRoom（在线成员广播大群），默认为ChatRoom（聊天室）</td><td style='text-align:center;' >群组状态</td><td style='text-align:center;' >否</td></tr><tr><td style='text-align:center;' >ApplyJoinOption</td><td style='text-align:center;' >FreeAccess（自由加入），NeedPermission（需要验证），DisableApply（禁止加群），默认为NeedPermission（需要验证）</td><td style='text-align:center;' >申请加群处理方式</td><td style='text-align:center;' >否</td></tr></tbody></table><h3><a name='header-c195' class='md-header-anchor '></a>Response Body</h3><p>返回结果形式为 json。</p><p>json格式返回创建成功结果：</p><pre class="md-fences md-end-block" lang="json"> <div class="CodeMirror cm-s-inner CodeMirror-wrap"><div style="overflow: hidden; position: relative; width: 3px; height: 0px; top: 0px; left: 4px;"></div><div class="CodeMirror-hscrollbar" style="left: 0px; min-height: 18px;"><div style="height: 100%; min-height: 1px; width: 0px;"></div></div><div class="CodeMirror-vscrollbar" style="min-width: 18px;"><div style="min-width: 1px; height: 0px;"></div></div><div class="CodeMirror-scrollbar-filler"></div><div class="CodeMirror-gutter-filler"></div><div class="CodeMirror-scroll" tabindex="-1"><div class="CodeMirror-sizer" style="margin-left: 0px; min-height: 0px;"><div style="position: relative; top: 0px;"><div class="CodeMirror-lines"><div style="position: relative; outline: none;"><div class="CodeMirror-measure"><div style="width: 50px; height: 50px; overflow-x: scroll;"></div></div><div class="CodeMirror-measure"></div><div style="position: relative; z-index: 1;"></div><div class="CodeMirror-code" style=""><div class="CodeMirror-activeline" style="position: relative;"><div class="CodeMirror-activeline-background CodeMirror-linebackground"></div><pre class=""><span style="padding-right: 0.1px;">{</span></pre></div><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"code"</span>: <span class="cm-string">"0"</span>,</span></pre><pre class=""><span style="padding-right: 0.1px;">  <span class="cm-string cm-property">"data"</span>: {</span></pre><pre class=""><span style="padding-right: 0.1px;"> &nbsp;  <span class="cm-string cm-property">"groupId"</span>: <span class="cm-string">"@TGS#3EH27XNEB"</span> &nbsp;  <span class="cm-comment">//聊天室ID</span></span></pre><pre class=""><span style="padding-right: 0.1px;">  }</span></pre><pre class=""><span style="padding-right: 0.1px;">}</span></pre></div></div></div></div></div><div style="position: absolute; height: 30px; width: 1px; top: 0px;"></div><div class="CodeMirror-gutters" style="display: none; height: 132px;"></div></div></div></pre><p></p></div>
</body>
</html>